Kotlin Computational Geometry/io.github.cponfick.kompgeom.euclidean.twod/Polygon2

Polygon2

class Polygon2(vertices: List<Vec2>, val precision: DoubleEquivalence = DEFAULT_DOUBLE_EQUIVALENCE) : Polygon<Vec2> (source)

Represents a polygon in 2D space defined by a list of vertices.

The polygon is defined by its vertices in order (either clockwise or counterclockwise). The last vertex is implicitly connected to the first vertex to close the polygon.

Constructors

Polygon2

constructor(vertices: List<Vec2>, precision: DoubleEquivalence = DEFAULT_DOUBLE_EQUIVALENCE)

Types

Companion

object Companion

Properties

edges

val edges: List<Seg2>

Returns the edges of the polygon as a list of segments.

precision

val precision: DoubleEquivalence

The precision used for geometric computations, defaulting to DEFAULT_DOUBLE_EQUIVALENCE.

vertexCount

open val vertexCount: Int

Returns the number of vertices in the polygon.

vertices

open override val vertices: List<Vec2>

An immutable snapshot of the vertices supplied to the constructor.

Functions

area

open override fun area(): Double

Computes the area of the polygon.

boundingBox

fun boundingBox(): Pair<Vec2, Vec2>

Computes the axis-aligned bounding box of the polygon.

centroid

open override fun centroid(): Vec2

Computes the centroid (geometric center) of the polygon.

component1

operator fun component1(): List<Vec2>

component2

operator fun component2(): DoubleEquivalence

contains

open override fun contains(point: Vec2): Boolean

Checks if a point is inside the polygon.

convexHull

fun convexHull(): Polygon2

Computes the convex hull of this polygon's vertices using the Quickhull2 algorithm.

copy

fun copy(vertices: List<Vec2> = this.vertices, precision: DoubleEquivalence = this.precision): Polygon2

Returns a polygon with the supplied vertices and precision.

dimensions

open override fun dimensions(): Int

Returns the number of dimensions of the spatial object.

equals

open operator override fun equals(other: Any?): Boolean

hashCode

open override fun hashCode(): Int

isConvex

open override fun isConvex(): Boolean

Checks if the polygon is convex.

isFinite

open override fun isFinite(): Boolean

Returns true if all values in the spatial are finite.

isInfinite

open override fun isInfinite(): Boolean

Returns true if any value in the spatial is infinite.

isNaN

open override fun isNaN(): Boolean

Returns true if any value in the spatial is NaN (Not a Number).

isSimple

open override fun isSimple(): Boolean

Checks if the polygon is simple (non-self-intersecting).

orientation

fun orientation(): Orientation

Determines the orientation of the polygon based on the sign of its area.

perimeter

open override fun perimeter(): Double

Computes the perimeter of the polygon.

reverse

open override fun reverse(): Polygon2

Reverses the order of vertices, effectively reversing the orientation of the polygon.

scale

open override fun scale(factor: Double, center: Vec2): Polygon2

Scales the polygon by a given factor around a center point.

signedArea

open override fun signedArea(): Double

Computes the signed area of the polygon.

toString

open override fun toString(): String

transform

open override fun transform(transformer: Transformer<Vec2>): Polygon2

Transforms the polygon by applying a transformation to all vertices.

translate

open override fun translate(offset: Vec2): Polygon2

Translates the polygon by a given offset vector.